package Class::Scaffold::BusinessObject;

# $Id: BusinessObject.pm 13653 2007-10-22 09:11:20Z gr $

use strict;
use warnings;
use Error::Hierarchy::Util 'assert_defined';


our $VERSION = '0.04';


use base qw(
    Class::Scaffold::Storable
    Class::Scaffold::HierarchicalDirty
);


__PACKAGE__
    ->mk_scalar_accessors(qw(key_name))
    ->mk_abstract_accessors(qw(key object_type));


use constant DEFAULTS => (
    key_name => 'key field',
);


# Each business object can tell its defining key, e.g. handle for persons,
# domainname for domains etc.

# check() is given an exception container, which it fills with exceptions that
# arise from checking. Since we're dealing exclusively with value objects, we
# can check for valid characters, field lengths, some wellformedness and
# validity (in case of email value objects, for example), all from within the
# business objects themselves. By moving part of the checking code into the
# objects themselves we make the policy stage more generic. Other registries
# can simply define business objects in terms of different value objects.

sub check {}


sub used_objects {
    my $self = shift;
    ($self->object_type => $self->key);
}


sub assert_key {
    my $self = shift;
    local $Error::Depth = $Error::Depth + 1;
    assert_defined $self->key,
       sprintf('called without defined %s', $self->key_name);
}


sub store {
    my $self = shift;

    if ($self->key) {
        $self->update;
    } else {
        $self->insert;
    }
}


use constant SKIP_COMPARABLE_KEYS => ('key_name');


# do nothing; subclasses will implement it
sub apply_instruction_container {}


1;


__END__

{% USE p = PodGenerated %}

=head1 NAME

{% p.package %} - large-scale OOP application support

=head1 SYNOPSIS

    {% p.package %}->new;

=head1 DESCRIPTION

=head1 METHODS

=over 4

{% p.write_methods %}

=back

{% p.write_inheritance %}

{% PROCESS standard_pod %}

=cut

